add keyword arguments to IOBuffer's constructors #25872
Conversation
bicycle1885
force-pushed
the
iobuffer-kwargs
branch
from
42ab52e
to
a556386
Compare
|
I think this is ready to review. Please ignore the last commit, which just removes a junk file I made accidentally. I'm still wondering whether we should choose Any comments? @vtjnash @StefanKarpinski |
base/iobuffer.jl
Outdated
| - `truncate`: truncates the buffer size to zero length. | ||
| - `maxsize`: specifies a size beyond which the buffer may not be grown. | ||
|
|
||
| When `data` is given, the buffer will be both readable and writable by default. |
There was a problem hiding this comment.
I don't think this is true --- the keyword arguments default to nothing, which open_flags interprets as read-only. And that's probably a good thing; for example we have
IOBuffer(str::String) = IOBuffer(unsafe_wrap(Vector{UInt8}, str))
which we want to remain read-only.
There was a problem hiding this comment.
You are right. I meant "When data is not given, ...". Fixed.
|
|
||
| julia> String(take!(io)) | ||
| "JuliaLang is a GitHub organization. It has many members." | ||
|
|
||
| julia> io = IOBuffer("JuliaLang is a GitHub organization.") | ||
| IOBuffer(data=UInt8[...], readable=true, writable=false, seekable=true, append=false, size=35, maxsize=Inf, ptr=1, mark=-1) |
There was a problem hiding this comment.
The examples don't include the truncate flag. As an aside, I guess I should write the code to figure out a minimal set of keywords to reproduce a particular set of open flags – this output is a bit on the long side.
There was a problem hiding this comment.
Thank you. I added some examples in #25919.
| maxsize=maxsize) | ||
| buf.data[:] = 0 | ||
| if flags.truncate | ||
| buf.size = 0 |
There was a problem hiding this comment.
Not important, just wondering: since truncate is also passed to the constructor above, is this redundant?
There was a problem hiding this comment.
Yes, it is. Fixed in #25919.
| @@ -512,7 +512,7 @@ isascii(s::AbstractString) = all(isascii, s) | |||
| ## string map, filter, has ## | |||
|
|
|||
| function map(f, s::AbstractString) | |||
| out = IOBuffer(StringVector(sizeof(s)), true, true) | |||
| out = IOBuffer(StringVector(sizeof(s)), read=true, write=true) | |||
There was a problem hiding this comment.
Passing a StringVector like this seems to be pretty common. It would be good to add a sizehint keyword argument so that you could just do IOBuffer(sizehint=sizeof(s)) here and in similar places.
There was a problem hiding this comment.
Okay, I'll take care of it.
This adds constructors of
IOBuffertaking keyword arguments (e.g.write=true) asopendoes, which will supersede #24430.TODO: